記錄自己的想法

註解程式碼缺陷

程式碼大多會持續改變，在過程中留下些缺陷，不要害怕記錄下缺陷：

// TODO:改用更快演算法

或程式碼不足之處：

// TODO(dustin):處理 JPEG 之外的影像格式

以下是需多程式設計師採用標記：

常數的註解

NUM_THREADS = 8

表面上看起來不需要註解，但選用這個數值程式設計師顯然知道些額外事情：

NUM_THREADS = 8  # 只要 >= 2 *num_processors 就夠好了

如此一來，讀者就有了調整常數值的指引。
某些常數只是單純的數值，沒有重要性，但是加上說明仍然有幫助:

// 加上合理的限制-沒有人能讀這麼多文章
const = int MAX_SUBSCRIPTIONS = 1000;

有些常數值是經過許多調校後的結果，不應該改動：

image_quality = 0.72;  //使用者認為 0.72 在大小/品質上有最好的平衡

這些例子大多數人不認為需要註解，但的確有所幫助。

Reference

• <<易讀程式之美學－提升程式碼可讀性的簡單法則 >>(The Art of Readable Code)